Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements to Traceable Integration #29129

Merged
merged 25 commits into from
Aug 30, 2023
Merged

Enhancements to Traceable Integration #29129

merged 25 commits into from
Aug 30, 2023

Conversation

mtraceable
Copy link
Contributor

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

  • In Progress
  • Ready
  • In Hold - (Reason for hold)

Related Issues

fixes: link to the issue

Description

Introduced new fields in the Incident to specify type of IP Address (ipAddressType) with values Internal or External
Introduced new fields in the Incident to specify type of API (apiType) with values Internal or External
Added new Incident field eventUrl containing the link to open the Incident Event in the Traceable Platform.
Ability to select the optional fields for the Incidents.
Ability to pull optional attributes of the affected APIs of the reported incidents:
Incidents for the selected HTTP Status Codes can now be ignored and not created in XSOAR.
Added additional input configuration for the Integration to provide the base url of the Traceable Platform UI endpoint.
Added additional input configuration to configure the HTTP Status Codes for which the Incidents should be ignored.
Updated the Docker image to: demisto/python3:3.10.12.68714.

Must have

  • Tests
  • Documentation

@content-bot content-bot added Contribution Thank you! Contributions are always welcome! External PR Partner Support Level Indicates that the contribution is for Partner supported pack labels Aug 22, 2023
@content-bot content-bot changed the base branch from master to contrib/mtraceable_dev-1 August 22, 2023 10:51
@MichaelYochpaz MichaelYochpaz self-assigned this Aug 22, 2023
@content-bot content-bot requested a review from ostolero August 22, 2023 10:52
@content-bot
Copy link
Collaborator

Thank you for your contribution. Your generosity and caring are unrivaled! Make sure to register your contribution by filling the Contribution Registration form, so our content wizard @ostolero will know the proposed changes are ready to be reviewed.
For your convenience, here is a link to the contributions SLAs document.

@MichaelYochpaz MichaelYochpaz changed the title Dev Enhancements to Traceable Integration Aug 22, 2023
@content-bot content-bot added Contribution Form Filled Whether contribution form filled or not. Partner labels Aug 22, 2023
@MichaelYochpaz MichaelYochpaz requested review from MichaelYochpaz and removed request for ostolero August 22, 2023 10:52
@MichaelYochpaz MichaelYochpaz added the pending-contributor The PR is pending the response of its creator label Aug 24, 2023
@MichaelYochpaz MichaelYochpaz added the ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR. label Aug 24, 2023
@content-bot
Copy link
Collaborator

content-bot commented Aug 24, 2023

For the Reviewer: Successfully created a pipeline in Gitlab with url: https://code.pan.run/xsoar/content/-/pipelines/6189790

@MichaelYochpaz
Copy link
Contributor

MichaelYochpaz commented Aug 27, 2023

@mtraceable Our internal build fails for:

/builds/xsoar/content/Packs/Traceable/Integrations/Traceable/Traceable.py:351:16: E9012 Client.__parse_status_code_strings: Demisto.log is found, Please replace all demisto.log usage with demisto.info or demisto.debug
/builds/xsoar/content/Packs/Traceable/Integrations/Traceable/Traceable.py:358:20: E9012 Client.__parse_status_code_strings: Demisto.log is found, Please replace all demisto.log usage with demisto.info or demisto.debug
/builds/xsoar/content/Packs/Traceable/Integrations/Traceable/Traceable.py:364:20: E9012 Client.__parse_status_code_strings: Demisto.log is found, Please replace all demisto.log usage with demisto.info or demisto.debug
/builds/xsoar/content/Packs/Traceable/Integrations/Traceable/Traceable.py:367:16: E9012 Client.__parse_status_code_strings: Demisto.log is found, Please replace all demisto.log usage with demisto.info or demisto.debug
/builds/xsoar/content/Packs/Traceable/Integrations/Traceable/Traceable.py:390:20: E9012 Client.__process_domain_event_field_list: Demisto.log is found, Please replace all demisto.log usage with demisto.info or demisto.debug

Please fix.
After that, the PR should be good to go :)

@MichaelYochpaz MichaelYochpaz added ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR. and removed ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR. labels Aug 28, 2023
@MichaelYochpaz
Copy link
Contributor

Hey @mtraceable, PR seems to be good :)

Please see this page, and message me in Slack (DFIR) when you're available for a demo so that I'll schedule a meeting.

@MichaelYochpaz MichaelYochpaz added pending-demo Demo pending and removed pending-contributor The PR is pending the response of its creator labels Aug 28, 2023
Copy link
Contributor

@MichaelYochpaz MichaelYochpaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mtraceable Demo went great, good job! :)

- Corrected log statements
- Added a unit test for eventUrl
required: false
- display: Incident optional field list
name: optionalDomainEventFieldList
defaultvalue: actorDevice,actorEntityId,actorId,actorScoreCategory,actorSession,anomalousAttribute,apiName,apiUri,category,ipAbuseVelocity,ipReputationLevel,securityEventType,securityScore,serviceId,serviceName,actorScore,threatCategory,type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need this (defaultvalue) if you have the list of options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ShirleyDenkberg the idea was to have it fetch as many fields to start with, and the customer can take a conscious decision to remove or retain the ones that they wish.

required: false
- display: Additional API Attributes
name: optionalAPIAttributes
defaultvalue: isExternal,isAuthenticated,riskScore,riskScoreCategory,isLearnt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need this (defaultvalue) if you have the list of options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ShirleyDenkberg same case here - the idea was to have it fetch as many fields to start with, and the customer can take a conscious decision to remove or retain the ones that they wish.

@ShirleyDenkberg
Copy link
Contributor

@MichaelYochpaz Doc review completed.

@MichaelYochpaz MichaelYochpaz merged commit 8cf9f18 into demisto:contrib/mtraceable_dev-1 Aug 30, 2023
MichaelYochpaz added a commit that referenced this pull request Aug 30, 2023
* Enhancements to Traceable Integration (#29129)

* Added new fields to the Incidents - ipAddressType and apiType

* - Adding Event url in the incident
- Adding ignore status codes
- Field to mark the affected api internal or external
- field to mark the actor ip address internal or external

* - Status code filtering
- Incident Field Selection
- Unit Tests

* - Changes for api attribute selections
- Additional unit tests

* Updated Release Notes.

* Removing unused Integration configurations.

* Readme changes.

* Logs causing failed Test

* - Fixed timestamps to include milliseconds. Else it misses capturing some spans.

* Fixing datetime strings and unit tests.

* removing unused imports

* Making logs less noisy.

* Logging changes.

* Safe value checking.

* Changes to Release Notes as per the findings from the pre-check

* Review comments for the Release Notes.

* Review Comments

* Review Comments - changing demisto.log to demisto.info.

* Pre-commit - changing the version of the docker image.

* Pre-commit - changing docker version in the release notes.

* Removing redundant point from the release notes.

* - Fixed a index out of bound error
- Corrected log statements
- Added a unit test for eventUrl

* Review comments for the README and ReleaseNotes.

* Add testing IP to secrets-ignore

---------

Co-authored-by: Mayuresh Kshirsagar <[email protected]>
Co-authored-by: Michael Yochpaz <[email protected]>
xsoar-bot pushed a commit to xsoar-contrib/content that referenced this pull request Oct 5, 2023
* Enhancements to Traceable Integration (demisto#29129)

* Added new fields to the Incidents - ipAddressType and apiType

* - Adding Event url in the incident
- Adding ignore status codes
- Field to mark the affected api internal or external
- field to mark the actor ip address internal or external

* - Status code filtering
- Incident Field Selection
- Unit Tests

* - Changes for api attribute selections
- Additional unit tests

* Updated Release Notes.

* Removing unused Integration configurations.

* Readme changes.

* Logs causing failed Test

* - Fixed timestamps to include milliseconds. Else it misses capturing some spans.

* Fixing datetime strings and unit tests.

* removing unused imports

* Making logs less noisy.

* Logging changes.

* Safe value checking.

* Changes to Release Notes as per the findings from the pre-check

* Review comments for the Release Notes.

* Review Comments

* Review Comments - changing demisto.log to demisto.info.

* Pre-commit - changing the version of the docker image.

* Pre-commit - changing docker version in the release notes.

* Removing redundant point from the release notes.

* - Fixed a index out of bound error
- Corrected log statements
- Added a unit test for eventUrl

* Review comments for the README and ReleaseNotes.

* Add testing IP to secrets-ignore

---------

Co-authored-by: Mayuresh Kshirsagar <[email protected]>
Co-authored-by: Michael Yochpaz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution Form Filled Whether contribution form filled or not. Contribution Thank you! Contributions are always welcome! docs-approved External PR Partner Support Level Indicates that the contribution is for Partner supported pack Partner Partner-Approved pending-demo Demo pending ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants